home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C / Applications / InterLaunch 1.1.2 / src / macppp / slhc.h < prev   
Text File  |  1995-06-07  |  6KB  |  150 lines
  1. #ifndef _SLHC_H
  2. #define _SLHC_H
  3. /*
  4.  * Definitions for tcp compression routines.
  5.  *
  6.  * $Header: slcompress.h,v 1.10 89/12/31 08:53:02 van Exp $
  7.  *
  8.  * Copyright (c) 1989 Regents of the University of California.
  9.  * All rights reserved.
  10.  *
  11.  * Redistribution and use in source and binary forms are permitted
  12.  * provided that the above copyright notice and this paragraph are
  13.  * duplicated in all such forms and that any documentation,
  14.  * advertising materials, and other materials related to such
  15.  * distribution and use acknowledge that the software was developed
  16.  * by the University of California, Berkeley.  The name of the
  17.  * University may not be used to endorse or promote products derived
  18.  * from this software without specific prior written permission.
  19.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  20.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  21.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  22.  *
  23.  *    Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
  24.  *    - Initial distribution.
  25.  *
  26.  *
  27.  * modified for KA9Q Internet Software Package by
  28.  * Katie Stevens (dkstevens@ucdavis.edu)
  29.  * University of California, Davis
  30.  * Computing Services
  31.  *    - 01-31-90    initial adaptation
  32.  *
  33.  *    - Feb 1991    Bill_Simpson@um.cc.umich.edu
  34.  *            variable number of conversation slots
  35.  *            allow zero or one slots
  36.  *            separate routines
  37.  *            status display
  38.  *
  39.  *  - 1993 Larry Blunk, Merit Network, Inc. / University of Michigan
  40.  *     changed code to use new buffer structure for MacPPP
  41.  */
  42.  
  43. /*
  44.  * Compressed packet format:
  45.  *
  46.  * The first octet contains the packet type (top 3 bits), TCP
  47.  * 'push' bit, and flags that indicate which of the 4 TCP sequence
  48.  * numbers have changed (bottom 5 bits).  The next octet is a
  49.  * conversation number that associates a saved IP/TCP header with
  50.  * the compressed packet.  The next two octets are the TCP checksum
  51.  * from the original datagram.  The next 0 to 15 octets are
  52.  * sequence number changes, one change per bit set in the header
  53.  * (there may be no changes and there are two special cases where
  54.  * the receiver implicitly knows what changed -- see below).
  55.  *
  56.  * There are 5 numbers which can change (they are always inserted
  57.  * in the following order): TCP urgent pointer, window,
  58.  * acknowlegement, sequence number and IP ID.  (The urgent pointer
  59.  * is different from the others in that its value is sent, not the
  60.  * change in value.)  Since typical use of SLIP links is biased
  61.  * toward small packets (see comments on MTU/MSS below), changes
  62.  * use a variable length coding with one octet for numbers in the
  63.  * range 1 - 255 and 3 octets (0, MSB, LSB) for numbers in the
  64.  * range 256 - 65535 or 0.  (If the change in sequence number or
  65.  * ack is more than 65535, an uncompressed packet is sent.)
  66.  */
  67.  
  68. /*
  69.  * Packet types (must not conflict with IP protocol version)
  70.  *
  71.  * The top nibble of the first octet is the packet type.  There are
  72.  * three possible types: IP (not proto TCP or tcp with one of the
  73.  * control flags set); uncompressed TCP (a normal IP/TCP packet but
  74.  * with the 8-bit protocol field replaced by an 8-bit connection id --
  75.  * this type of packet syncs the sender & receiver); and compressed
  76.  * TCP (described above).
  77.  *
  78.  * LSB of 4-bit field is TCP "PUSH" bit (a worthless anachronism) and
  79.  * is logically part of the 4-bit "changes" field that follows.  Top
  80.  * three bits are actual packet type.  For backward compatibility
  81.  * and in the interest of conserving bits, numbers are chosen so the
  82.  * IP protocol version number (4) which normally appears in this nibble
  83.  * means "IP packet".
  84.  */
  85.  
  86. /* SLIP compression masks for len/vers byte */
  87. #define SL_TYPE_IP 0x40
  88. #define SL_TYPE_UNCOMPRESSED_TCP 0x70
  89. #define SL_TYPE_COMPRESSED_TCP 0x80
  90. #define SL_TYPE_ERROR 0x00
  91.  
  92. /* Bits in first octet of compressed packet */
  93. #define NEW_C    0x40    /* flag bits for what changed in a packet */
  94. #define NEW_I    0x20
  95. #define NEW_S    0x08
  96. #define NEW_A    0x04
  97. #define NEW_W    0x02
  98. #define NEW_U    0x01
  99.  
  100. /* reserved, special-case values of above */
  101. #define SPECIAL_I (NEW_S|NEW_W|NEW_U)        /* echoed interactive traffic */
  102. #define SPECIAL_D (NEW_S|NEW_A|NEW_W|NEW_U)    /* unidirectional data */
  103. #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
  104.  
  105. #define TCP_PUSH_BIT 0x10
  106.  
  107. /*
  108.  * "state" data for each active tcp conversation on the wire.  This is
  109.  * basically a copy of the entire IP/TCP header from the last packet
  110.  * we saw from the conversation together with a small identifier
  111.  * the transmit & receive ends of the line use to locate saved header.
  112.  */
  113. struct cstate {
  114.     b_8    this;        /* connection id number (xmit) */
  115.     struct cstate *next;    /* next in ring (xmit) */
  116.     struct ipheader cs_ip;    /* ip/tcp hdr from most recent packet */
  117.     struct tcpheader cs_tcp;
  118. };
  119. #define NULLSLSTATE    (struct cstate *)0
  120.  
  121. /*
  122.  * all the state data for one serial line (we need one of these per line).
  123.  */
  124. struct slcompress {
  125.     struct cstate *tstate;    /* transmit connection states (array)*/
  126.     struct cstate *rstate;    /* receive connection states (array)*/
  127.  
  128.     b_8 tslot_limit;    /* highest transmit slot id (0-l)*/
  129.     b_8 rslot_limit;    /* highest receive slot id (0-l)*/
  130.  
  131.     b_8 xmit_oldest;    /* oldest xmit in ring */
  132.     b_8 xmit_current;    /* most recent xmit id */
  133.     b_8 recv_current;    /* most recent rcvd id */
  134.  
  135.     b_8 flags;
  136. #define SLF_TOSS    0x01    /* tossing rcvd frames until id received */
  137.  
  138. };
  139. #define NULLSLCOMPR    (struct slcompress *)0
  140.  
  141. /* In slhc.c: */
  142. void    slhc_init(LapInfo *, short, short);
  143.  
  144. short        slhc_compress(LapInfo *, struct bufheader *, short);
  145. short        slhc_uncompress(LapInfo *, struct bufheader *);
  146. short        slhc_remember(LapInfo *, struct bufheader *);
  147. short        slhc_toss(struct slcompress *);
  148.  
  149. #endif    /* _SLHC_H */
  150.